package org.jsola.contract.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.contract.dto.PersonSignatureAddDTO;
import org.jsola.contract.dto.PersonSignatureUpdateDTO;
import org.jsola.contract.query.PersonSignatureQuery;
import org.jsola.contract.vo.PersonSignatureListVO;
import org.jsola.contract.vo.PersonSignatureVO;
import org.jsola.core.Page;
import org.jsola.core.Result;

import java.util.List;

/**
 * 合同个人签名表
 *
 * @author JanusMix
 */
@Api(tags = "contract-合同个人签名表")
public interface IPersonSignatureControllerAPI {

    /**
     * 新增合同个人签名表
     * @param personSignatureAddDTO 合同个人签名表新增实体
     * @return 合同个人签名表展示对象
     */
    @ApiOperation(value = "新增合同个人签名表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "personSignatureAddDTO", dataType = "PersonSignatureAddDTO", value = "新增合同个人签名表", paramType = "body")
    })
    Result<PersonSignatureVO> save(PersonSignatureAddDTO personSignatureAddDTO);


    /**
     * 修改合同个人签名表
     * @param personSignatureUpdateDTO 合同个人签名表
     * @return 更新数量
     */
    @ApiOperation(value = "修改合同个人签名表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "personSignatureUpdateDTO", dataType = "PersonSignatureUpdateDTO", value = "修改合同个人签名表", paramType = "body")
    })
    Result<Integer> update(PersonSignatureUpdateDTO personSignatureUpdateDTO);




    /**
     * 删除单个合同个人签名表，彻底删除
     * @param personSignatureId 合同个人签名表id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个合同个人签名表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "personSignatureId", dataType = "Long", value = "合同个人签名表id", paramType = "path")
    })
    Result<Integer> delete(Long personSignatureId);


    /**
     * 批量删除合同个人签名表，彻底删除
     * @param personSignatureIds 合同个人签名表id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除合同个人签名表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "personSignatureIds", dataType = "Long[]", value = "合同个人签名表id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(Long[] personSignatureIds);


    /**
     * 根据合同个人签名表id查询合同个人签名表详情
     * @param personSignatureId 合同个人签名表id
     * @return 合同个人签名表详情
     */
    @ApiOperation(value="根据合同个人签名表id查询合同个人签名表详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "personSignatureId", dataType = "Long", value = "合同个人签名表id", paramType = "path")
    })
    Result<PersonSignatureVO> findById(Long personSignatureId);


    /**
     * 查询合同个人签名表
     * @param personSignatureQuery 合同个人签名表查询参数
     * @return page
     */
    @ApiOperation(value="查询合同个人签名表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "personSignatureQuery", dataType = "PersonSignatureQuery", value = "合同个人签名表查询参数", paramType = "query")
    })
    Result<List<PersonSignatureListVO>> listAll(PersonSignatureQuery personSignatureQuery);


     /**
     * 分页查询合同个人签名表
     * @param personSignatureQuery 合同个人签名表查询参数
     * @return page
     */
    @ApiOperation(value="分页查询合同个人签名表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "personSignatureQuery", dataType = "PersonSignatureQuery", value = "合同个人签名表查询参数", paramType = "query")
    })
    Result<Page<PersonSignatureListVO>> page(PersonSignatureQuery personSignatureQuery);


}

